Strip control characters from contract read output - #2672
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Sanitizes contract read string output to prevent terminal control-sequence injection.
Changes:
- Extracts ledger-entry formatting into
entry_record. - Sanitizes string-formatted keys and values.
- Adds a unit regression test for malicious symbols.
fnando
force-pushed
the
sanitize-contract-read-output
branch
from
August 10, 2026 18:03
f69f615 to
6e9435d
Compare
mootz12
approved these changes
Aug 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Sanitizes the key/value fields in
stellar contract read's default (--output string) output so control and escape sequences can no longer reach the terminal unescaped. The per-entry record building is extracted into a smallentry_recordhelper and theStringbranch now wrapssoroban_spec_tools::to_stringwithsoroban_spec_tools::sanitize. A regression test covers a top-levelScVal::Symbolcarrying escape bytes.Why
soroban_spec_tools::to_stringreturns raw, unescaped bytes for a top-levelScVal::Symbol, and the default output writes those straight to the terminal via the CSV writer. Every other output mode (JSON/XDR) already escapes its content, and the auth-entry signing prompt was hardened the same way in #2667. This applies the same defense-in-depth to thecontract readdisplay path so untrusted ledger content cannot smuggle terminal escape sequences into a user's terminal.Known limitations
N/A